===============================================================================================

ImageCode workshop upload tool for Street Legal Racing: Redline, copyright ImageCode LLC., 2018

===============================================================================================

Follow these instructions to use the tool:

To create the new workshop item, locate "run_create.bat", right-click it and select "Modify" or simply open it with any text editor (for example, Notepad++), you must get this:

-------------
workshop_uploader -m "create" -t "Workshop item" -d "This item has been created with ImageCode workshop upload tool" -v "private" -c "car, engine" -p "preview_image.jpg" -sc "screenshots" -yt "https://www.youtube.com/watch?v=m7ZC_6VVGrc, https://www.youtube.com/watch?v=rKpxopPsY7c, https://www.youtube.com/watch?v=jy9ym2pLoBc" -f "content" -uc "Initial workshop item release"
-------------

The first parameter, "workshop_uploader", is a name of workshop tool application without .exe extension, other parameters must be listed as key->value pairs divided by spaces, otherwise utility could not read them correctly. Name of workshop tool must always be the first parameter.

You need to edit these parameters, here is the description that should help you:

-------------
Parameter	Purpose																	Possible values
-m			Uploader mode															create, modify, delete, info
-id			Item identifier															Integer with a positive value
-t			Title of your workshop item												Arbitrary value
-d			Description of item														Arbitrary value
-v			Visibility flag															public, private, friends
-c			Item category															car, bike, other vehicle, engine, running gear, body, decoration, interior, other part, gamemode, career event, misc, decal, color, drift track, drag track, circuit track, stunt track, other track
-p			Filename of preview image												Arbitrary value
-sc			Screenshots folder name													Arbitrary value
-yt			YouTube videos to describe your item in the best way					Arbitrary value
-f			Content folder name, this folder stores all your workshop item files	Arbitrary value
-uc			Release notes															Arbitrary value		
-------------

Even despite this tool supports Unicode, It's NOT recommended to use non-latin symbols in file or folder names, application may not identify them or simply crash. Use only english names to avoid this. Also make sure that application has no limitations on connecting to the internet before running it. If you can't upload files, disable your anti-virus software and firewalls.

Always use double quotation marks to define parameter values:

-------------
"example of using double quotation marks, look at left and right sides of this message"
-------------

The -m flag defines the mode of workshop uploader:

-------------
-m create
-------------

You can list all your published workshop items with it:

-------------
-m info
-------------

To hide your item from other users, define:

-------------
-v "private"
-------------

If you want your item to be visible to friends only, define:

-------------
-v "friends"
-------------

The -c flag defines category of your item. For example, if you're uploading a car, define:

-------------
-c "car"
-------------

Or if you're uploading running gear part, define:

-------------
-c "running gear"
-------------

If you don't know the category of your item, just define:

-------------
-c "misc"
-------------

The -id flag might be useful if you already know your workshop item ID and don't want to pick item from the list when modifying or deleting it:

-------------
-id 18237622
-------------

Use -uc flag to tell about the changes you made to your workshop item. Keep in mind, you'll see release notes on your workshop item page only if you have modified its content. Here's an example of how you can use it:

-------------
-uc "Version 2.0, improved texture resolution."
-------------

List of categories may be extended or changed, you can access it on workshop main page.

IMPORTANT: All YouTube links must look like this:

-------------
https://www.youtube.com/watch?v=pGV9L4eY8KY
-------------

i.e. they must contain the link prefix:

-------------
https://www.youtube.com/watch?v=
-------------

and the code of video:

-------------
pGV9L4eY8KY
-------------

YouTube link MUST NOT contain something after the code. For example, this link is incorrect:

-------------
https://www.youtube.com/watch?v=JJ3p3QQcFcM&feature=youtu.be
-------------

In this example YouTube link contains "&feature=youtu.be" after the code and therefore, it's invalid and won't be parsed correctly by the utility. Preview image and all screenshots must have JPG format and .jpg extension! Other filetypes and extensions are not supported. Max image file size: 1MB.

Special notes on using workshop uploader in a modify mode (-m modify):

1. First of all, look at the examples in run_modify.bat, run_modify_2.bat and run_modify_3.bat. You can modify all parameters of your workshop item, as described in run_modify.bat or just modify some individual parameters (for example, only title and description)

2. If you remember workshop item ID, you can specify it in .bat file with -id flag, so workshop uploader will start working immediately, without waiting for feedback from you. Workshop item ID can be obtained in info mode (-m info), check run_info.bat for details.

3. There's a special behavior of workshop uploader in a modify mode: if you specify screenshots, but don't include YouTube links, the application will remove old YouTube links if you had them defined in initial release. It's a bit complicated for explanation, just try to modify YouTube links and screenshots together, so the uploader won't delete something against your will.

4. Release notes (-uc flag) are being published to your workshop item only if you make changes to the content (i.e. you use -f flag in modify mode)

How to use delete mode (-m delete):

1. Easiest way is just to run example_delete.bat. If you have previously published workshop items, application will ask you to select which one to delete. Press "1", "2" or other digital key on your keyboard to define item index, then press Enter to confirm.

2. A bit more sophisticated way to delete item is described in example_delete_2.bat, where you can specify ID of workshop item you'd like to delete.

How to use info mode (-m info): Just run example_info.bat, no any additional action required.

You're ready to use workshop uploader now! Run Steam client and login into your account, save run_create.bat file and run it by double-clicking or pressing enter, the application will begin working. Don't interrupt uploading process after "UPLOADING CONTENT, PLEASE WAIT" and "UPDATING WORKSHOP ITEM, PLEASE WAIT" messages, otherwise your workshop item will be corrupted or the changes you made won't take effect!

After that, you can check your uploaded item in Steam workshop and edit title, description, links or categories.


==================
If this tool is running incorrectly, if it's asking some DLL or just crashes on your computer, please, let report to support@image-code.com, we highly appreciate your feedback and will do our best on improving this utility.